com.highdeal.rangetable.hci

Class RangeTableClassModel

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.rangetable.hci.RangeTableClassModel

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMapping, XMLMarshallable, ICatalogObject

public class RangeTableClassModel
extends HCIModelAdapter
implements XMLMapping, ICatalogObject

This Java class represents a range table class that defines a table scheme; It specifies the structure of a range table (or subscriber range table), with the number and the type of output columns.

This class is then referenced by the RangeTableModel to instantiate them.

Note

Refer to the SAP CC Application Help for more information about this business concept and master data.

Related Operations

• CreateRangeTableClassOp
• SearchRangeTableClassOp
• ModifyRangeTableClassOp
• DeleteRangeTableClassOp

See Also:

RangeTableModel, SubscriberRangeTableModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="RangeTableClassType">
   <xs:sequence>
     <xs:element name="description" type="DescriptionType" minOccurs="1" maxOccurs="1" />
     <xs:element name="additionalInfo" type="AdditionalInfoType" minOccurs="0" maxOccurs="unbounded" />
     <xs:element name="outColumn" type="OutColumnType" minOccurs="1" maxOccurs="15"/>
   </xs:sequence>
   <xs:attribute name="id" type="xs:string" />
   <xs:attribute name="owner" type="xs:string" />
   <xs:attribute name="rangeUpperBound" type="RangeBoundType" />
   <xs:attribute name="lastRange" type="LastRangeType" />
 </xs:complexType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RangeTableClassModel.LastRange This enumeration lists all the definitions for a range upper bound (bounded, unbounded).
static class	RangeTableClassModel.RangeBound This enumeration lists all the out range table class attributes (inclusive, exclusive).

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_OUT_COLUMN The maximum number of out columns: 15
static String	TAG_NAME The XML tag name of this data model: "rangeTableClass"

Constructor Summary

Constructors

Constructor and Description
RangeTableClassModel() Default range table class constructor.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
List<AdditionalInfoModel>	getAdditionalInfoList() Gets the list of information dedicated to external system.
Class<?>	getClass(String nsUri, String tag, XMLAttributes atts) Returns the Java class for a specified XML tag and its attributes in a namespace.
String	getDescription() Gets the range table description.
String	getId() Gets the range table identifier.
RangeTableClassModel.LastRange	getLastRange() Gets the lastRange type of the range table.
List<RangeTableClassOutColumnModel>	getOutColumns() Gets the output columns of the range table.
String	getOwner() Gets the owner of the range table.
RangeTableClassModel.RangeBound	getRangeUpperBound() Gets the rangeUpperBound of the range table rows.
String	getTagName() Gets the XML tag of this HCI model.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setDescription(String description) Sets the description of the range table.
void	setId(String id) Sets the identifier of the range table.
void	setLastRange(RangeTableClassModel.LastRange lastRange) Sets the lastRange type of the range table.
void	setOwner(String owner) Sets the owner of the range table.
void	setRangeUpperBound(RangeTableClassModel.RangeBound rangeUpperBound) Sets the rangeUpperBound of the range table rows.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

The XML tag name of this data model: "rangeTableClass"

See Also:

Constant Field Values

MAX_OUT_COLUMN

public static final int MAX_OUT_COLUMN

The maximum number of out columns: 15

See Also:

Constant Field Values

Constructor Detail

RangeTableClassModel

public RangeTableClassModel()

Default range table class constructor.

Method Detail

getId

public String getId()

Gets the range table identifier.

Returns:

A string that contains the identifier of the range table

setId

public void setId(String id)

Sets the identifier of the range table.

Parameters:

id - The identifier to set to this range table

getDescription

public String getDescription()

Gets the range table description.

Returns:

A string that contains the description of the range table

setDescription

public void setDescription(String description)

Sets the description of the range table.

Parameters:

description - The description to set to this range table

getOwner

public String getOwner()

Gets the owner of the range table.

Specified by:

getOwner in interface ICatalogObject

Returns:

A string that contains the owner of the range table

setOwner

public void setOwner(String owner)

Sets the owner of the range table.

Parameters:

owner - The owner to set to this range table

getRangeUpperBound

public RangeTableClassModel.RangeBound getRangeUpperBound()

Gets the rangeUpperBound of the range table rows.

Returns:

The rangeUpperBound of the range table rows

See Also:

setRangeUpperBound(RangeTableClassModel.RangeBound), RangeTableClassModel.RangeBound

setRangeUpperBound

public void setRangeUpperBound(RangeTableClassModel.RangeBound rangeUpperBound)

Sets the rangeUpperBound of the range table rows.

Parameters:

rangeUpperBound - The rangeUpperBound of the range table rows

See Also:

RangeTableClassModel.RangeBound

getLastRange

public RangeTableClassModel.LastRange getLastRange()

Gets the lastRange type of the range table.

Returns:

The last range type of the range table

See Also:

setLastRange(RangeTableClassModel.LastRange), RangeTableClassModel.LastRange

setLastRange

public void setLastRange(RangeTableClassModel.LastRange lastRange)

Sets the lastRange type of the range table.

Parameters:

lastRange - The LastRange of the range table

See Also:

RangeTableClassModel.LastRange

getOutColumns

public List<RangeTableClassOutColumnModel> getOutColumns()

Gets the output columns of the range table.

Returns:

A list that contains all the output columns

getAdditionalInfoList

public List<AdditionalInfoModel> getAdditionalInfoList()

Gets the list of information dedicated to external system. The designer of the range table adds information allowing an external system to search its specific range tables. An additional information is a property defined by its name and its value.

Returns:

The list of information dedicated to external system

getTagName

public String getTagName()

Gets the XML tag of this HCI model.

Specified by:

getTagName in interface ITagNameProvider

Returns:

A string containing the XML tag of mapping table model

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Specified by:

marshalAttributes in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Specified by:

marshalChildren in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the child objects into

getClass

public Class<?> getClass(String nsUri,
                         String tag,
                         XMLAttributes atts)

Description copied from interface: XMLMapping

Returns the Java class for a specified XML tag and its attributes in a namespace.

Specified by:

getClass in interface XMLMapping

Parameters:

nsUri - The unique resource identifier of the namespace of the XML tag

tag - The local part of the XML tag

atts - The attributes of the XML tag

Returns:

A Java class with a default constructor